/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.web.portlet.description.impl;

import com.genia.toolbox.basics.i18n.I18nMessage;
import com.genia.toolbox.basics.i18n.I18nMessageFactory;
import com.genia.toolbox.constants.client.i18n.ErrorDescriptions;

/**
 * implementation of the <code>VariableDescription</code> for a variable of
 * type <code>Long</code>.
 */
public class LongVariableDescription
    extends SimpleVariableDescription
{

  /**
   * i18n message for a parsing error.
   */
  public static final I18nMessage PARSE_ERROR_MESSAGE = I18nMessageFactory.getIl8nMessage(ErrorDescriptions.LONG_PARSE_ERROR_KEY);

  /**
   * minimal value of the variable.
   */
  private long minValue;

  /**
   * maximal value of the variable.
   */
  private long maxValue;



  /**
   * Constructor without range specification.
   */
  public LongVariableDescription()
  {
    this(Long.MIN_VALUE, Long.MAX_VALUE);
  }



  /**
   * Constructor with a range specification.
   * 
   * @param minValue
   *          the minimal value that the variable can have.
   * @param maxValue
   *          the maximal value that the variable can have.
   */
  public LongVariableDescription(final long minValue, final long maxValue)
  {
    this.minValue = minValue;
    this.maxValue = maxValue;
  }



  /**
   * This method check that the value entered for this variable is correct. It
   * return <code>null</code> if this is the case. Otherwise it returns the
   * internationalisation key of the error message.
   * 
   * @param value
   *          the value to check
   * @return <code>null</code> of the value of the variable is correct, the
   *         internationalisation message the error otherwise.
   * @see com.genia.toolbox.web.portlet.description.VariableDescription#accept(java.lang.String)
   */
  @Override
  public I18nMessage accept(final String value)
  {
    try {
      final long valueAsLong = Long.parseLong(value);
      if (valueAsLong < minValue || valueAsLong > maxValue) {
        return I18nMessageFactory.getIl8nMessage(ErrorDescriptions.RANGE_ERROR_KEY, minValue, maxValue);
      }
    }
    catch (final Exception e) {
      return PARSE_ERROR_MESSAGE;
    }
    return null;
  }



  /**
   * getter for the minValue property.
   * 
   * @return the minValue
   */
  public long getMinValue()
  {
    return minValue;
  }



  /**
   * setter for the minValue property.
   * 
   * @param minValue
   *          the minValue to set
   */
  public void setMinValue(long minValue)
  {
    this.minValue = minValue;
  }



  /**
   * getter for the maxValue property.
   * 
   * @return the maxValue
   */
  public long getMaxValue()
  {
    return maxValue;
  }



  /**
   * setter for the maxValue property.
   * 
   * @param maxValue
   *          the maxValue to set
   */
  public void setMaxValue(long maxValue)
  {
    this.maxValue = maxValue;
  }

}
